Data Manager Documentation Update #951
Conversation
…python into data-manager-docs
jspeerless
requested review from
anoto-moniz,
kroenlein,
xperrylinn and
pacdaemon
There was a problem hiding this comment.
Markdown formatting standard at Citrine is one sentence per line, and breaking that line into individual clauses across lines if that one line gets too long. By doing that, you avoid confusing diffs triggered when words move past an 80-character threshold.
These comments change no content, and only apply the above rule.
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
…python into data-manager-docs
There was a problem hiding this comment.
Mostly good. Some suggested changes, plus the following required updates to the indexes (deploy will fail b/c of build warnings):
- You deleted molecular_generation.rst, but you didn't delete the reference to it from index.rst.
- You deleted team_management_migration.rst, but you didn't delete the reference to it from FAQ/index.rst.
- You didn't add data_manager_migration to FAQ/index.rst.
|
|
||
| # Doing any operations (updating, deleting, dumping, etc.) to Datasets or GEMD Assets via a | ||
| # Project collection | ||
| project.[datasets/gemd_objects].... |
There was a problem hiding this comment.
You should never have been able to do this along a project-based route for GEMD objects. It always required a dataset (maybe delete was an exception? Definitely true for update). In the past, that returned a simple error. @pacdaemon and @anoto-moniz might have accidentally made something broken when they added their deprecations there.
| # Doing any operations (updating, deleting, dumping, etc.) to Datasets or GEMD Assets via a | |
| # Project collection | |
| project.[datasets/gemd_objects].... | |
| # Doing any operations (updating, deleting, etc.) to Datasets via a Project collection | |
| project.datasets.delete(uid) |
There was a problem hiding this comment.
I thought the actions were just read-only if only the project was reference. E.g. .list() or .get() would work, but not register or update
There was a problem hiding this comment.
Addressed, though I used "update" as an example since we use "delete before. Still not sure about whether or not we allow update or other things from the team-level endpoints.
There was a problem hiding this comment.
@kroenlein To clarify, is there something in the SDK code that makes you think something's broken? Or are you just saying this line of the documentation was wrong?
There was a problem hiding this comment.
I ran it locally and got a giant splat of exception handling that did not indicate the real problem. However, I then ran the same code with v3.2.11 and got the same error, so if we have more elegant handling in the past, that was last in a previous release.
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
Co-authored-by: Ken Kroenlein <51962276+kroenlein@users.noreply.github.com>
…python into data-manager-docs
Citrine Python PR
Description
Updates to our documentation to account for changes brought on by the Data Manager feature.
Includes changes to remove inaccurate docs and code examples after the migration to teams and up to 3.0 as well.
Note that I mostly focused on directing users to the correct endpoints in the Data Manager world and remove things that were just plain wrong, not completely overhaul our docs (which might be a good use of time at some point).
PR Type:
Adherence to team decisions